Get all quests

GET 
/quests

This endpoint returns all quests

Request

Query Parameters

owner string
status string

Possible values: [active, inactive]

Responses

200

A list of quests

application/json

Schema

Schema

• Array [

name stringrequired

a unique name for the quest

owner stringrequired

the primary owner of the quest, an id from the buddy-auth service (e.g. GET /user)

image stringrequired

a unique name for the quest

displayName stringrequired

a vanity name for the quest

status stringrequired

Possible values: [active, inactive]

the status of the quest

config

object

required

pointValue integerrequired

the number of points the quest is worth

repeatFrequency stringrequired

Possible values: [none, hourly, daily, weekly, monthly, yearly]

how often the quest can be repeated

MaximumTimeToComplete integerrequired

the maximum time to complete the quest in hours

useLastSuccessAsEpoch booleanrequired

whether to use the last success as the epoch for the next repeat

timezone stringrequired

offset from UTC e.g. -07:00

repeatLimit integerrequired

the number of times the quest can be repeated, 0 for unlimited

trigger

object

type stringrequired

the type of trigger (e.g. webhook, cron, social)

provider stringrequired

the provider of the trigger (e.g. twitter, github, cron)

args objectrequired

the arguments for the trigger, see documentation for each provider

• ]

Example (from schema)

[
  {
    "name": "string",
    "owner": "string",
    "image": "string",
    "displayName": "string",
    "status": "active",
    "config": {
      "pointValue": 0,
      "repeatFrequency": "none",
      "MaximumTimeToComplete": 0,
      "useLastSuccessAsEpoch": true,
      "timezone": "string",
      "repeatLimit": 0
    },
    "trigger": {
      "type": "string",
      "provider": "string",
      "args": {}
    }
  }
]

Loading...